home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Vk / VkMenuToggle.z / VkMenuToggle
Encoding:
Text File  |  2002-10-03  |  7.2 KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkMMMMeeeennnnuuuuTTTToooogggggggglllleeee((((3333xxxx))))                                              VVVVkkkkMMMMeeeennnnuuuuTTTToooogggggggglllleeee((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkMenuToggle - Class that support two-state actions in menus
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkMenuAction : VkMenuItem : VkComponent : VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkMenuItem.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.            VkMenuToggle(const char *, XtCallbackProc, XtPointer);
  20.            VkMenuToggle(const char *, XtCallbackProc,
  21.                         XtCallbackProc, XtPointer);
  22.            ~VkMenuToggle();
  23.  
  24.  
  25.    MMMMaaaannnniiiippppuuuullllaaaattttiiiinnnngggg MMMMeeeennnnuuuu IIIItttteeeemmmmssss
  26.            void setVisualState(Boolean state);
  27.            void setStateAndNotify(Boolean);
  28.  
  29.  
  30.    AAAAcccccccceeeessssssss FFFFuuuunnnnccccttttiiiioooonnnnssss
  31.            virtual const char* className();
  32.            virtual VkMenuItemType menuType ();
  33.            Boolean getState();
  34.  
  35.  
  36. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  37.      The VkMenuToggle class represents a user-selectable two-state button in a
  38.      menu.  Objects of type VkMenuToggle can be placed in any VkMenu subclass.
  39.      The VkMenuToggle adds an XmToggleButton gadget into its parent menu pane.
  40.      Like all VkMenuItems, VkMenuToggle objects can be activated, deactivated,
  41.      replaced, and so on.
  42.  
  43.      If an action has an undo callback, the object automatically registers
  44.      itself with an instance of the VkUndoManager class when the action is
  45.      executed. An undo callback can be specified when the object is
  46.      instantiated.
  47.  
  48. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  49.    VVVVkkkkMMMMeeeennnnuuuuTTTToooogggggggglllleeee
  50.            VkMenuToggle(const char *, XtCallbackProc, XtPointer);
  51.            VkMenuToggle(const char *, XtCallbackProc,
  52.                         XtCallbackProc, XtPointer);
  53.  
  54.  
  55.           Construct a VkMenuAction object. No widgets are built in the
  56.           constructor.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkMMMMeeeennnnuuuuTTTToooogggggggglllleeee((((3333xxxx))))                                              VVVVkkkkMMMMeeeennnnuuuuTTTToooogggggggglllleeee((((3333xxxx))))
  71.  
  72.  
  73.  
  74.    ~~~~VVVVkkkkMMMMeeeennnnuuuuTTTToooogggggggglllleeee
  75.            ~VkMenuToggle();
  76.  
  77.  
  78.           Clean up on destruction of a VkMenuToggle object.
  79.  
  80.    ccccllllaaaassssssssNNNNaaaammmmeeee
  81.            virtual const char* className();
  82.  
  83.  
  84.           Returns "VkMenuToggle".
  85.  
  86.    mmmmeeeennnnuuuuTTTTyyyyppppeeee
  87.            virtual VkMenuItemType menuType ();
  88.  
  89.      Returns VkMenuItem::TOGGLE
  90.  
  91.    sssseeeettttVVVViiiissssuuuuaaaallllSSSSttttaaaatttteeee
  92.            void setVisualState(Boolean state);
  93.  
  94.  
  95.           If _s_t_a_t_e is TRUE, this function "sets" the toggle button. If FALSE,
  96.           this function unsets the button. No callbacks are invoked.
  97.  
  98.    sssseeeettttSSSSttttaaaatttteeeeAAAAnnnnddddNNNNoooottttiiiiffffyyyy
  99.            void setStateAndNotify(Boolean state);
  100.  
  101.  
  102.           If _s_t_a_t_e is TRUE, this function "sets" the toggle button. If FALSE,
  103.           this function unsets the button. Any callbacks associated with this
  104.           item are called when the state changes.
  105.  
  106.  
  107.    ggggeeeettttSSSSttttaaaatttteeee
  108.            Boolean getState();
  109.  
  110.  
  111.           Return the current value of the VkMenuToggle item.
  112.  
  113. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  114.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkMMMMeeeennnnuuuuAAAAccccttttiiiioooonnnn
  115.           undo(),  hasUndo(),  _undoCallback _func,  _data,
  116.  
  117.  
  118.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkMMMMeeeennnnuuuuIIIItttteeeemmmm
  119.           show(), hide(), manageAll(), setLabel(), setPosition(), activate(),
  120.           deactivate(), remove(), show(), isContainer(), _position, _isBuilt,
  121.           _sensitive, _parentMenu, _label, _isHidden, _unmanagedWidgets,
  122.           _numUnmanagedWidgets,
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkMMMMeeeennnnuuuuTTTToooogggggggglllleeee((((3333xxxx))))                                              VVVVkkkkMMMMeeeennnnuuuuTTTToooogggggggglllleeee((((3333xxxx))))
  137.  
  138.  
  139.  
  140.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  141.           installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
  142.           setDefaultResources(), getResources(), manage(), unmanage(),
  143.           baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback
  144.  
  145.  
  146.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  147.           callCallbacks(), addCallback(), removeCallback(),
  148.           removeAllCallbacks()
  149.  
  150.  
  151. KKKKNNNNOOOOWWWWNNNN CCCCLLLLAAAASSSSSSSSEEEESSSS TTTTHHHHAAAATTTT UUUUSSSSEEEE TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  152.      VkMenu, VkMenuToggle
  153.  
  154. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  155.      VkMenuAction, VkMenuItem, VkComponent, VkMenu
  156.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  157.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  158.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  159.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.